Support Flexible Sync #5301

elle-j · 2023-01-23T07:08:19Z

What, How & Why?

Adds support for Flexible Sync and Asymmetric Sync.

Flexible Sync:

Open a Flexible Sync realm by providing a realm configuration containing flexible: true and optionally an initialSubscriptions object:

const realmConfig: Configuration = {
  sync: {
    user,
    flexible: true,
    initialSubscriptions: {
      update: (mutableSubscriptions, realm) => {
        // ...
      } 
    },
  },

  // Other fields..
};

Get a realm's subscription set: realm.subscriptions
Manipulate the subscription set:

await realm.subscriptions.update(mutableSubs => {
  mutableSubs.add(realm.objects("Cat").filtered("age > 10"));
  mutableSubs.add(realm.objects("Dog").filtered("age > 20"), { name: "oldDogs" });
  mutableSubs.removeByName("youngDogs");
});

Asymmetric Sync:

User can set asymmetric: true in schema of a Realm object. If set, then:
- Realm.create() will return undefined rather than the object itself.
- Querying asymmetric object(s) will throw an error.

Review Notes:

packages/realm/src/schema/validate.ts does not need to be reviewed. The content here has merely been moved from Configuration.ts.

API change:

Internal:
- Opening a synced realm locally:
  - Previous realm config type: { sync?: SyncConfiguration | true } where sync must be true.
  - New realm config type: { sync?: SyncConfiguration; openSyncedRealmLocally?: true }

Will be added in a separate PR:

Implementation of JS array methods on BaseSubscriptionSet such as join, filter, every, concat, etc. so that it can extend ReadonlyArray<Subscription>.

This closes #4806 and #5270.

☑️ ToDos

🚦 Tests
🔀 Executed flexible sync tests locally if modifying flexible sync

…edocs.

packages/realm/src/Realm.ts

packages/realm/src/app-services/BaseSubscriptionSet.ts

packages/realm/src/app-services/SubscriptionSet.ts

elle-j · 2023-01-23T08:02:47Z

packages/realm/src/schema/validate.ts

+////////////////////////////////////////////////////////////////////////////
+//


This file does not need to be reviewed. The content is merely moved from Configuration.ts into this /schema/validate.ts file.

packages/realm/src/Configuration.ts

integration-tests/tests/src/tests/sync/asymmetric.ts

integration-tests/tests/src/tests/sync/flexible.ts

packages/bindgen/src/realm_js_helpers.h

packages/realm/src/Configuration.ts

packages/realm/src/Realm.ts

packages/realm/src/app-services/BaseSubscriptionSet.ts

packages/realm/src/app-services/SubscriptionSet.ts

packages/realm/src/app-services/BaseSubscriptionSet.ts

kneth · 2023-01-24T13:24:52Z

packages/realm/src/index.ts

  RealmEventName,
  RealmListenerCallback,
+  SubscriptionOptions,


@kraenhansen Do you know why?

takameyer

Great work! I have a few general questions just to broaden my understanding of things (could be answered by other reviewers). Other than that, I would like my this.timeout issue to be addressed and this is good to go in my eyes 👍🏼

integration-tests/tests/src/tests/sync/flexible.ts

integration-tests/tests/src/tests/sync/sync-as-local.ts

takameyer · 2023-01-24T14:45:03Z

packages/realm/src/Configuration.ts

-  const { path, schema, onMigration, sync } = config;
-  if (typeof onMigration !== "undefined") {
-    assert.function(onMigration, "migration");
+  assert.object(config, "realm configuration", { allowArrays: false });


That would make sense. What's holding that back?

takameyer · 2023-01-24T14:59:45Z

packages/realm/src/Realm.ts

@@ -593,11 +630,11 @@ export class Realm {
    this.syncSession?.resetInternal();
  }

-  // TODO: Support embedded objects and asymmetric sync
+  // TODO: Support embedded objects


Just a general question, but do we have a task to track this? I haven't heard embedded object support mentioned in any of our planning meetings

I thought we already supported them. If not, I would expect (hope!) that we would have some failing tests related to that.

packages/realm/src/Realm.ts

takameyer · 2023-01-24T15:07:11Z

packages/realm/src/Results.ts

@@ -75,6 +75,10 @@ export class Results<T = unknown> extends OrderedCollection<T> {
    return this.internal.size();
  }

+  description(): string {


General question: is the description the filtered string?

Yes, it is core's representation of the query. Some SDKs are not using RQL so it is a serialization of the query.

packages/realm/src/app-services/BaseSubscriptionSet.ts

packages/realm/src/app-services/SyncConfiguration.ts

kneth

Once the comments have been resolved, it is ready to be merged.

It is a very big PR, and it has many moving parts. I am happy to see that you have been able to pull it through.

packages/realm/src/app-services/BaseSubscriptionSet.ts

packages/realm/src/app-services/SubscriptionSet.ts

integration-tests/tests/src/tests/sync/flexible.ts

RedBeard0531 · 2023-01-25T10:50:17Z

integration-tests/tests/src/tests/sync/asymmetric.ts

@@ -45,24 +45,41 @@ describe.skipIf(environment.missingServer, "Asymmetric sync", function () {
      },
    });

-    it("Schema with asymmetric = true and embedded = false", function () {
+    it("Schema with asymmetric = true and embedded = false", function (this: RealmContext) {


(General comment, not specific to this line)

Should any of these changes be backported to the master branch or are they bindgen-specific? Ideally, we want the tests in bindgen and master to be as in-sync as possible since that is how we are ensuring that we don't change behavior (except where we intend to!)

packages/bindgen/spec.yml

packages/bindgen/src/realm_js_helpers.h

packages/realm/src/app-services/SyncConfiguration.ts

RedBeard0531 · 2023-01-26T13:00:37Z

packages/realm/src/app-services/SyncConfiguration.ts

+/**
+ * Validate the fields of a user-provided realm sync configuration.
+ */
+export function validateSyncConfiguration(config: unknown): asserts config is SyncConfiguration {


@internal?

Also I'm not sure if it is a good idea to split parsing and validation like this. It seems easy for them to get out of sync. Not sure if you want to change this now, but something to consider adding to a todo list.

I'll make a note of this 👍 Also good to be discussed in the team.

packages/realm/src/app-services/SyncConfiguration.ts

Co-authored-by: Kræn Hansen <[email protected]>

kraenhansen and others added 23 commits January 18, 2023 14:09

Refactored Realm constructor

050bb2e

Implement Subscription.

8c91182

Implement BaseSubscriptionSet.

26b26d0

Update spec.yaml and expose helper functions.

1843c76

Implement MutableSubscriptionSet.

e31fc4e

Implement SubscriptionSet.

b0fed0d

Handle configuration with flexible set to true.

8ccfdb6

Increase timeout for Flexible Sync tests.

94ecc6a

Add subscription classes to Sync namespace.

e911755

Refactor SubscriptionSet.update() into separate async and sync methods.

0bfc50e

Validate realm configuration.

3714923

Handle initial subscriptions.

5e2c864

Update expected error messages for tests.

c1f65ff

Move schema validation from Configuration.ts to /schema directory.

b1d27c9

Import types instead of accessing them through Realm namespace in Typ…

eb72a08

…edocs.

Update variable names.

2a63ad8

Support Asymmetric Sync.

41e098a

Enable previously skipped tests.

2d638a7

Change test to not accept 'flexible: false'.

bf33629

Allow opening a synced realm locally.

6c5ad82

Use BaseSubscriptionSet as a proxy to allow index access operator.

ef248ea

Rearrange if-conditions for increased readability.

9ef8cc2

Refactor subscription classes to use parameter properties.

20405a0

cla-bot bot added the cla: yes label Jan 23, 2023

elle-j commented Jan 23, 2023

View reviewed changes

packages/realm/src/Realm.ts Outdated Show resolved Hide resolved

elle-j commented Jan 23, 2023

View reviewed changes

packages/realm/src/app-services/BaseSubscriptionSet.ts Show resolved Hide resolved

elle-j commented Jan 23, 2023

View reviewed changes

packages/realm/src/app-services/BaseSubscriptionSet.ts Outdated Show resolved Hide resolved

elle-j commented Jan 23, 2023

View reviewed changes

packages/realm/src/app-services/SubscriptionSet.ts Show resolved Hide resolved

elle-j commented Jan 23, 2023

View reviewed changes

packages/realm/src/Configuration.ts Show resolved Hide resolved

elle-j requested review from kneth and takameyer January 23, 2023 08:20

elle-j mentioned this pull request Jan 23, 2023

Support Asymmetric Sync #5180

Closed

1 task

kraenhansen reviewed Jan 23, 2023

View reviewed changes

integration-tests/tests/src/tests/sync/asymmetric.ts Outdated Show resolved Hide resolved

elle-j added 3 commits January 24, 2023 10:00

Make 'this.realm' available in asymmetric tests.

1858124

Make subscription sets iterable.

2cdd147

Fix bug when removing a subscription by object type.

8f395b1

kneth reviewed Jan 24, 2023

View reviewed changes

takameyer approved these changes Jan 24, 2023

View reviewed changes

elle-j added 4 commits January 25, 2023 10:49

Add 'isAsymmetric()' and 'isEmbedded()' helpers.

1d32347

Add '@example' to TSDocs.

aefa998

Validate schema version is 0 or positive integer.

3cced95

Validate sync config before getting a sync session.

bb7024d

kneth approved these changes Jan 26, 2023

View reviewed changes

packages/realm/src/app-services/BaseSubscriptionSet.ts Show resolved Hide resolved

packages/realm/src/app-services/BaseSubscriptionSet.ts Outdated Show resolved Hide resolved

packages/realm/src/app-services/SubscriptionSet.ts Show resolved Hide resolved

RedBeard0531 reviewed Jan 26, 2023

View reviewed changes

elle-j added 9 commits January 27, 2023 10:31

Remove unnecessary copy of variable.

8189f83

Update comments and minor refactor.

3c7ffab

Set timeout in tests to same as CI, and small refactor.

6faba8d

Remove redundant docs.

4a0834f

Update assert error messages for consistency.

822766e

Remove redundant docs.

2d5c694

Replace string with char.

60a27c6

Add '@internal' to validation functions.

c7a3e2a

Resolved merge conflict.

2eafc6f

elle-j merged commit 75c35d8 into bindgen Jan 27, 2023

elle-j deleted the lj/bindgen/flexible-sync branch January 27, 2023 15:51

kraenhansen mentioned this pull request Feb 16, 2023

Realm constructor refactor #5286

Closed

kraenhansen added a commit that referenced this pull request Mar 1, 2023

Support Flexible Sync (#5301)

a639f91

Co-authored-by: Kræn Hansen <[email protected]>

kraenhansen added a commit that referenced this pull request Mar 3, 2023

Support Flexible Sync (#5301)

bface7d

Co-authored-by: Kræn Hansen <[email protected]>

github-actions bot locked as resolved and limited conversation to collaborators Mar 15, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support Flexible Sync #5301

Support Flexible Sync #5301

elle-j commented Jan 23, 2023 •

edited

Loading

elle-j Jan 23, 2023 •

edited

Loading

kneth Jan 24, 2023

takameyer left a comment

takameyer Jan 24, 2023

takameyer Jan 24, 2023

RedBeard0531 Jan 25, 2023

takameyer Jan 24, 2023

kneth Jan 26, 2023

kneth left a comment

RedBeard0531 Jan 25, 2023

RedBeard0531 Jan 26, 2023

elle-j Jan 26, 2023

		////////////////////////////////////////////////////////////////////////////
		//

Support Flexible Sync #5301

Support Flexible Sync #5301

Conversation

elle-j commented Jan 23, 2023 • edited Loading

What, How & Why?

☑️ ToDos

elle-j Jan 23, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

takameyer left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kneth left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

elle-j commented Jan 23, 2023 •

edited

Loading

elle-j Jan 23, 2023 •

edited

Loading